Alias

SignerProcessDocumentResultUpdate

Description

Establishes the result of the signature of a document in a document signature process.

Request

PUT /trustedx-resources/esignsp/v2/signer_processes/{signature_process_id}/documents/{doc_id}/result

Parameters

Name	Type	Usage	Description
`signature_process_id`	path	Required	Identifier of the document signature process in which the signing of the document takes place for which the result is to be established.
doc_id	path	Required	Identifier of the document in the process whose signature result is to be established.

Content-Type Header

Content-Type: application/json

Body

The body of the request contains the following JSON object:

{
    "status": {string},
    "details": {
        "message": {string}
    }
}

Property

Usage

Description

status

Required

Result assigned to the signature of the document:

"finished": The document was signed correctly.
"failed": The document was not signed because an error occurred.
"canceled": The document was not signed because its signature was canceled.

details.message

Optional

Additional information on the result of the document signing.

Authorization

The request must contain a bearer access token generated by an authorization server of the platform. This token must have a scope that includes the urn:safelayer:eidas:sign:process:document value and must be used as explained in RFC 6750. Basically, the access token must be included in an Authorization header as follows:

Authorization: Bearer <token>

The access token must be obtained via a client credentials grant type OAuth 2.0 flow.

Response

Status-Line

If the result of the document is established successfully, the HTTP response will contain the following Status-Line (see HTTP Response Status for all the possible cases).

HTTP/1.1 200 OK

Content-Type Header

Content-Type: application/json

Body

If the result of the signature of the document is successfully established, the body of the response contains the JSON object included in the request.

{
    "status": {string},
    "details": {
        "message": {string}
    }
}